Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

GSoC`22 - Refactored workbench to react+typescript v4.0 & schema updates for latest version #532

Merged

Conversation

OmkarPh
Copy link
Collaborator

@OmkarPh OmkarPh commented Aug 15, 2022

Signed-off-by: Omkar Phansopkar [email protected]

@OmkarPh OmkarPh force-pushed the v4.0-react-typescript branch from 6e0b541 to b51019b Compare August 17, 2022 12:11
Signed-off-by: Omkar Phansopkar <[email protected]>
* test

Signed-off-by: Omkar Phansopkar <[email protected]>

* Try CI release

Signed-off-by: Omkar Phansopkar <[email protected]>

* Updated CI

Signed-off-by: Omkar Phansopkar <[email protected]>

* trial 1

Signed-off-by: Omkar Phansopkar <[email protected]>

* t2

Signed-off-by: Omkar Phansopkar <[email protected]>

* t3

Signed-off-by: Omkar Phansopkar <[email protected]>

* Platform specific tar names

Signed-off-by: Omkar Phansopkar <[email protected]>

* Fix workflow yml

Signed-off-by: Omkar Phansopkar <[email protected]>

* Fix workflow yml again

Signed-off-by: Omkar Phansopkar <[email protected]>

* Fix workflow yml againn

Signed-off-by: Omkar Phansopkar <[email protected]>

* Fix workflow yml againnn

Signed-off-by: Omkar Phansopkar <[email protected]>

* Fix workflow yml againnn

Signed-off-by: Omkar Phansopkar <[email protected]>

* Fix workflow yml againnn

Signed-off-by: Omkar Phansopkar <[email protected]>

* Add new release workflow job

Signed-off-by: Omkar Phansopkar <[email protected]>

* Updated release workflow job

Signed-off-by: Omkar Phansopkar <[email protected]>

* Updated release workflow job t7

Signed-off-by: Omkar Phansopkar <[email protected]>

* Updated release workflow job t8

Signed-off-by: Omkar Phansopkar <[email protected]>

* Updated release workflow job t8.1

Signed-off-by: Omkar Phansopkar <[email protected]>

* Updated release workflow job t8.2

Signed-off-by: Omkar Phansopkar <[email protected]>

* Updated release workflow job t8.3

Signed-off-by: Omkar Phansopkar <[email protected]>

* Updated release workflow job t8.5

Signed-off-by: Omkar Phansopkar <[email protected]>

* Updated release workflow job t8.5

Signed-off-by: Omkar Phansopkar <[email protected]>

* Updated release workflow job t9

Signed-off-by: Omkar Phansopkar <[email protected]>

* Updated release workflow job t9

Signed-off-by: Omkar Phansopkar <[email protected]>

* Updated release workflow job t9.1

Signed-off-by: Omkar Phansopkar <[email protected]>

* Updated release workflow job t9.2

Signed-off-by: Omkar Phansopkar <[email protected]>

* Updated release workflow job t9.3

Signed-off-by: Omkar Phansopkar <[email protected]>

* Added release workflow for linux & windows

Signed-off-by: Omkar Phansopkar <[email protected]>

* Matrix for OS

Signed-off-by: Omkar Phansopkar <[email protected]>

* Release beta 4.0.0

Signed-off-by: Omkar Phansopkar <[email protected]>

* Release test

Signed-off-by: Omkar Phansopkar <[email protected]>

* Release test2

Signed-off-by: Omkar Phansopkar <[email protected]>

* Release test3

Signed-off-by: Omkar Phansopkar <[email protected]>

* Release test4

Signed-off-by: Omkar Phansopkar <[email protected]>

* Release test5

Signed-off-by: Omkar Phansopkar <[email protected]>

* Release test with get tag

Signed-off-by: Omkar Phansopkar <[email protected]>

* Update for push

Signed-off-by: Omkar Phansopkar <[email protected]>

* Beta release

Signed-off-by: Omkar Phansopkar <[email protected]>

* Arm beta

Signed-off-by: Omkar Phansopkar <[email protected]>

* Release arm test2

Signed-off-by: Omkar Phansopkar <[email protected]>

* Release arm test3

Signed-off-by: Omkar Phansopkar <[email protected]>

* Fix invalid os

Signed-off-by: Omkar Phansopkar <[email protected]>

* Finalized Release yml

Signed-off-by: Omkar Phansopkar <[email protected]>

* Removed residue code

Signed-off-by: Omkar Phansopkar <[email protected]>

Signed-off-by: Omkar Phansopkar <[email protected]>
…windows instead of tar

Signed-off-by: Omkar Phansopkar <[email protected]>
* Powershell script in python t1

Signed-off-by: Omkar Phansopkar <[email protected]>

* Powershell script in python t2

Signed-off-by: Omkar Phansopkar <[email protected]>

* Removed comments

Signed-off-by: Omkar Phansopkar <[email protected]>

* Removed residue

Signed-off-by: Omkar Phansopkar <[email protected]>

Signed-off-by: Omkar Phansopkar <[email protected]>
* Basic interface for top level packages

Signed-off-by: Omkar Phansopkar <[email protected]>

* Completed package & dependency definitions

Signed-off-by: Omkar Phansopkar <[email protected]>

* Type-classified packages

Signed-off-by: Omkar Phansopkar <[email protected]>

* Updated UI for beta2 release

Signed-off-by: Omkar Phansopkar <[email protected]>

* Created primary fields and badges

Signed-off-by: Omkar Phansopkar <[email protected]>

Signed-off-by: Omkar Phansopkar <[email protected]>
@OmkarPh
Copy link
Collaborator Author

OmkarPh commented Sep 17, 2022

Signed-off-by: Omkar Phansopkar <[email protected]>
Copy link
Member

@AyanSinhaMahapatra AyanSinhaMahapatra left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great, thanks! We should merge and cut a release after reviewing.

@pombredanne could you try out and approve?

@OmkarPh OmkarPh changed the title Refactored workbench to react+typescript v4.0 GSoC`22 - Refactored workbench to react+typescript v4.0 Sep 19, 2022
Copy link
Contributor

@steven-esser steven-esser left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the hard work @OmkarPh, this is great.

I will leave it to @pombredanne and the nexB team to determine how/when they want to merge this in and release a new version.

Signed-off-by: Omkar Phansopkar <[email protected]>
Signed-off-by: Omkar Phansopkar <[email protected]>
Signed-off-by: Omkar Phansopkar <[email protected]>
notes.txt Outdated Show resolved Hide resolved
credits.txt Outdated
@@ -0,0 +1,4 @@
@TODO - Add these in about section -
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need an ABOUT file for this.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hey, @pombredanne
can you share an example or basic Outline for this ABOUT file
@AyanSinhaMahapatra , maybe you've some inputs on this

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@OmkarPh sorry I missed this,

Basically a download_url with license/copyright information and any other info you can find for giving credits/attribution. You might also need to add a copy of the license file if applicable, like the second example above in some cases depending on the license.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've created about file for the image asset https://github.com/OmkarPh/scancode-workbench/blob/v4.0-react-typescript/assets.ABOUT
I also added it in attribution window

Rest, I couldn't find any piece of code that I've directly copied from the internet
except for the official docs

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use license instead of usage_terms, and the about file should be just beside the file which you are describing, and the filename would be: addFiles.png.ABOUT.

The terms and conditions in https://storyset.com/terms looks good to me, since it says The authorization to use the Storyset Content shall be free provided that any use of the Storyset Content by the User is credited to the Company/Website as stated by the Company from time to time. but this needs to also be reviewed by @pombredanne .

Thanks!

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The TOS are significantly more complex than the "Authorization to use...." sentence so we need to look at the whole TOS. I do not see a problem, but we need to review in more detail.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@martin-langhoff
Copy link

Testing your PR

  • branch builds on my Mac OS 12.6.1 with Node from Brew (whereas develop is broken on node-gyp)
  • tested with an input report.json built with latest 'develop' commit in scancode-toolkit, the test run was over the git source code repo
  • Import worked well
  • In dashboard, Copyright Holders looks a bit odd (screencap below)
  • License info dashboard had no data, this is incorrect (JSON file has license data)

image

@martin-langhoff
Copy link

Also, npm install had all sorts of complaints about versions being stale and in conflict. So the good news is npm-gyp behaved. But npm thinks deps are stale and the developer should run npm audit to figure out what deps have critical updates.

@OmkarPh
Copy link
Collaborator Author

OmkarPh commented Dec 3, 2022

Thanks for your review. @martin-langhoff

  • branch builds on my Mac OS 12.6.1 with Node from Brew (whereas develop is broken on node-gyp)

yeah, 'develop' is the legacy code, so we don't expect wonders from it ;)

tested with an input report.json built with latest 'develop' commit in scancode-toolkit, the test run was over the git source code repo

the schema in workbench needs some minor updates to support the latest scancode-toolkit scans, that's our next goal

  • In dashboard, Copyright Holders looks a bit odd (screencap below)

we've to look for a better charts library, that handles such responsive issues

License info dashboard had no data, this is incorrect (JSON file has license data)

it's again because of non-updated schema ;)

PS: In case you want to use the workbench for usage, other than testing
You can use this for now https://github.com/OmkarPh/scancode-workbench/releases/tag/v4.0.0_beta4

@OmkarPh
Copy link
Collaborator Author

OmkarPh commented Jan 6, 2023

hi @pombredanne
any update on this :)

OmkarPh added 2 commits April 7, 2023 01:31
* Updated schema for header info

Signed-off-by: Omkar Phansopkar <[email protected]>

* Updated schema & ux for license detections, packages

Signed-off-by: Omkar Phansopkar <[email protected]>

* License detections explorer menu

Signed-off-by: Omkar Phansopkar <[email protected]>

* Removed residue columns for older license format

Signed-off-by: Omkar Phansopkar <[email protected]>

* Merged license keys with URLs in match table

Signed-off-by: Omkar Phansopkar <[email protected]>

* Testing License keys parser

Signed-off-by: Omkar Phansopkar <[email protected]>

* Completed license detection match table UI

Signed-off-by: Omkar Phansopkar <[email protected]>

* Updated UX & schema for latest output LicenseDetections

Signed-off-by: Omkar Phansopkar <[email protected]>

* Tableview scoped filters, Header-less import, filename in titlebar, format & crash fixes

Signed-off-by: Omkar Phansopkar <[email protected]>

* Ignored directories when preparing chart data

Signed-off-by: Omkar Phansopkar <[email protected]>

* Package_data fields, file & package info dashboard, chart empty labels

Signed-off-by: Omkar Phansopkar <[email protected]>

* Completed all pie charts

Signed-off-by: Omkar Phansopkar <[email protected]>

* New window, Info dash fixes, Completed matches table, fixed flatFiles, spdx parsing for matches

Signed-off-by: Omkar Phansopkar <[email protected]>

---------

Signed-off-by: Omkar Phansopkar <[email protected]>
…f detection.identifier)

Signed-off-by: Omkar Phansopkar <[email protected]>
@OmkarPh OmkarPh changed the title GSoC`22 - Refactored workbench to react+typescript v4.0 GSoC`22 - Refactored workbench to react+typescript v4.0 & schema updates for latest version Apr 7, 2023
Copy link
Member

@AyanSinhaMahapatra AyanSinhaMahapatra left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@OmkarPh Thanks a lot for the amazing work! This is fantastic. I've tested out the linux build locally and works great. So please go ahead and merge this as is and we'll track more improvements separately. Thank you for the quick fixes on the JSONStreams dependency issue and other open issues opened by @mjherzog too.

A few nits: we need to update the sample scans and readme to be consistent with our workbench supported versions on scancode-toolkit and also document this well enough so there's no confusion, but I'll open a separate issue for that.

Thanks ++ again

Signed-off-by: Omkar Phansopkar <[email protected]>
@OmkarPh OmkarPh merged commit bd7c7b1 into aboutcode-org:v4.0-react-typescript Apr 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants